<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>Root::Directory::Sub::Class class | My Project</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">My Project</a>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Pages</a></li>
            <li><a href="namespaces.html">Namespaces</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="namespaceRoot.html">Root</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespaceRoot_1_1Directory.html">Directory</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespaceRoot_1_1Directory_1_1Sub.html">Sub</a>::<wbr/></span>Class <span class="m-thin">class</span>
          <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="Class_8h.html">&lt;Directory/Sub/Class.h&gt;</a></div>
        </h1>
        <p>A class.</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              <a href="#Class-section">A section</a>
              <ul>
                <li><a href="#Class-sub-section">Subsection</a></li>
                <li>
                  <a href="#Class-sub-section2">Subsection 2</a>
                  <ul>
                    <li><a href="#Class-sub-section3">Subsection 3</a></li>
                  </ul>
                </li>
              </ul>
            </li>
            <li><a href="#Class-section2">Section 2</a></li>
            <li>
              Reference
              <ul>
                <li><a href="#pub-types">Public types</a></li>
                <li><a href="#pub-static-attribs">Public static variables</a></li>
                <li><a href="#pub-static-methods">Public static functions</a></li>
                <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
                <li><a href="#pub-methods">Public functions</a></li>
                <li><a href="#pub-attribs">Public variables</a></li>
                <li><a href="#pro-types">Protected types</a></li>
                <li><a href="#pro-static-methods">Protected static functions</a></li>
                <li><a href="#pro-methods">Protected functions</a></li>
                <li><a href="#pro-static-attribs">Protected static variables</a></li>
                <li><a href="#pro-attribs">Protected variables</a></li>
                <li><a href="#pri-methods">Private functions</a></li>
                <li><a href="#group-full-of-non-public-stuff-which-should-be-marked-as-such">Group full of non-public stuff which should be marked as such</a></li>
                <li><a href="#related">Related</a></li>
              </ul>
            </li>
          </ul>
        </nav>
<section id="Class-section"><h2><a href="#Class-section">A section</a></h2><p>Text.</p><section id="Class-sub-section"><h3><a href="#Class-sub-section">Subsection</a></h3></section><section id="Class-sub-section2"><h3><a href="#Class-sub-section2">Subsection 2</a></h3><section id="Class-sub-section3"><h4><a href="#Class-sub-section3">Subsection 3</a></h4></section></section></section><section id="Class-section2"><h2><a href="#Class-section2">Section 2</a></h2><p><a href="#a912d8f1390853f90e0a9f19ec98771e6" class="m-doc">Link to this page shouldn&#x27;t contain the filename</a> while <a href="namespaceRoot_1_1Directory.html#acdc29819d61c01eed9c74242010a7601" class="m-doc">link to another page should</a>. Same with <a href="#Class-section" class="m-doc">section references</a> vs <a href="page-no-toc.html#section-notoc" class="m-doc">external pages</a>.</p></section>
        <section id="pub-types">
          <h2><a href="#pub-types">Public types</a></h2>
          <dl class="m-doc">
            <dt>
              struct <a href="structRoot_1_1Directory_1_1Sub_1_1Class_1_1Foo.html" class="m-doc">Foo</a>
            </dt>
            <dd>A public subclass.</dd>
            <dt id="a5436ccacac4eb56e594b3c8f20a78a95">
              <span class="m-doc-wrap-bumper">enum <a href="#a5436ccacac4eb56e594b3c8f20a78a95" class="m-doc-self">E</a> { </span><span class="m-doc-wrap"><a href="#a5436ccacac4eb56e594b3c8f20a78a95ab40890227c995cba62c5ba928fa05797" class="m-doc">FooBar</a> = 3 }</span>
            </dt>
            <dd>A enum value.</dd>
            <dt id="af68c16757e5d0c83765cff3837952b8b">
              using <a href="#af68c16757e5d0c83765cff3837952b8b" class="m-doc-self">Deleter</a> = void(*)(int, void*)
            </dt>
            <dd>A public typedef.</dd>
          </dl>
        </section>
        <section id="pub-static-attribs">
          <h2><a href="#pub-static-attribs">Public static variables</a></h2>
          <dl class="m-doc">
            <dt id="a912d8f1390853f90e0a9f19ec98771e6">
              static int <a href="#a912d8f1390853f90e0a9f19ec98771e6" class="m-doc-self">Size</a> <span class="m-label m-flat m-primary">constexpr</span>
            </dt>
            <dd>A public static var.</dd>
          </dl>
        </section>
        <section id="pub-static-methods">
          <h2><a href="#pub-static-methods">Public static functions</a></h2>
          <dl class="m-doc">
            <dt id="abc9f4f532d25aa0d957a183098f2291d">
              <span class="m-doc-wrap-bumper">static void <a href="#abc9f4f532d25aa0d957a183098f2291d" class="m-doc-self">damage</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>A public static function.</dd>
          </dl>
        </section>
        <section id="typeless-methods">
          <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
          <dl class="m-doc">
            <dt id="a01c99be667ab8ee934e9f94da744ea83">
              <span class="m-doc-wrap-bumper"><a href="#a01c99be667ab8ee934e9f94da744ea83" class="m-doc-self">Class</a>(</span><span class="m-doc-wrap">int,
              void*) <span class="m-label m-flat m-info">explicit</span>  <span class="m-label m-flat m-primary">constexpr</span> <span class="m-label m-flat m-success">noexcept</span></span>
            </dt>
            <dd>A constructor without parameter names.</dd>
            <dt id="a55a51bc352524f6da634bb257d69a784">
              <span class="m-doc-wrap-bumper"><a href="#a55a51bc352524f6da634bb257d69a784" class="m-doc-self">Class</a>(</span><span class="m-doc-wrap"><a href="classRoot_1_1Directory_1_1Sub_1_1Class.html" class="m-doc">Class</a>&amp;) <span class="m-label m-flat m-danger">deleted</span></span>
            </dt>
            <dd>Deleted copy.</dd>
            <dt id="ae8ec516d48f6045f9fd7c08ba724bf6e">
              <span class="m-doc-wrap-bumper"><a href="#ae8ec516d48f6045f9fd7c08ba724bf6e" class="m-doc-self">operator bool</a>(</span><span class="m-doc-wrap">) const &amp;&amp; <span class="m-label m-flat m-info">explicit</span> </span>
            </dt>
            <dd>A conversion operator that works only on &amp;&amp;.</dd>
            <dt id="a7f5debd40ecca62a7ee98cd83858c013">
              <span class="m-doc-wrap-bumper"><a href="#a7f5debd40ecca62a7ee98cd83858c013" class="m-doc-self">~Class</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-warning">protected</span> <span class="m-label m-flat m-warning">pure virtual</span></span>
            </dt>
            <dd>A protected pure virtual destructor.</dd>
          </dl>
        </section>
        <section id="pub-methods">
          <h2><a href="#pub-methods">Public functions</a></h2>
          <dl class="m-doc">
            <dt id="ad749cc571894bad6cb3b23b1f4527233">
              <span class="m-doc-wrap-bumper">auto <a href="#ad749cc571894bad6cb3b23b1f4527233" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap"><a href="classRoot_1_1Directory_1_1Sub_1_1Class.html" class="m-doc">Class</a>&amp;&amp;) -&gt; <a href="classRoot_1_1Directory_1_1Sub_1_1Class.html" class="m-doc">Class</a>&amp; <span class="m-label m-flat m-info">defaulted</span></span>
            </dt>
            <dd>Defaulted move.</dd>
          </dl>
        </section>
        <section id="pub-attribs">
          <h2><a href="#pub-attribs">Public variables</a></h2>
          <dl class="m-doc">
            <dt id="ad877084846b47e5504224c72aa49d399">
              std::string <a href="#ad877084846b47e5504224c72aa49d399" class="m-doc-self">debug</a>
            </dt>
            <dd>A public variable.</dd>
          </dl>
        </section>
        <section id="pro-types">
          <h2><a href="#pro-types">Protected types</a></h2>
          <dl class="m-doc">
            <dt>
              <div class="m-doc-template">template&lt;class T, class U = void&gt;</div>
              union <a href="unionRoot_1_1Directory_1_1Sub_1_1Class_1_1Bar.html" class="m-doc">Bar</a>
            </dt>
            <dd>A protected subclass.</dd>
            <dt id="a0d7a4c92456263a36bd0819d9f26c996">
              <span class="m-doc-wrap-bumper">enum <a href="#a0d7a4c92456263a36bd0819d9f26c996" class="m-doc-self">Boolean</a> { </span><span class="m-doc-wrap"><a href="#a0d7a4c92456263a36bd0819d9f26c996ac8702eedbc992251f82e762161e1abf7" class="m-doc">True</a>,
              <a href="#a0d7a4c92456263a36bd0819d9f26c996ac3788e41d3959f1e2592b2789b2c2651" class="m-doc">False</a>,
              <a href="#a0d7a4c92456263a36bd0819d9f26c996a584feb009cffeb8f24c00613b65189dd" class="m-doc">FileNotFound</a> }</span>
            </dt>
            <dd>Protected enum.</dd>
            <dt id="ad4571bbf02497aa3e998918dcee071fc">
              using <a href="#ad4571bbf02497aa3e998918dcee071fc" class="m-doc-self">Type</a> = double
            </dt>
            <dd>A protected alias.</dd>
          </dl>
        </section>
        <section id="pro-static-methods">
          <h2><a href="#pro-static-methods">Protected static functions</a></h2>
          <dl class="m-doc">
            <dt id="a493c315509b0c10158bdc5dd229ea1bf">
              <span class="m-doc-wrap-bumper">static void <a href="#a493c315509b0c10158bdc5dd229ea1bf" class="m-doc-self">repair</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>A protected static function.</dd>
          </dl>
        </section>
        <section id="pro-methods">
          <h2><a href="#pro-methods">Protected functions</a></h2>
          <dl class="m-doc">
            <dt id="a5ae387679a842b33720c0ceadb2583a0">
              <span class="m-doc-wrap-bumper">auto <a href="#a5ae387679a842b33720c0ceadb2583a0" class="m-doc-self">fetchMeSomeIntegers</a>(</span><span class="m-doc-wrap">) const -&gt; int <span class="m-label m-flat m-primary">constexpr</span></span>
            </dt>
            <dd>Protected function.</dd>
          </dl>
        </section>
        <section id="pro-static-attribs">
          <h2><a href="#pro-static-attribs">Protected static variables</a></h2>
          <dl class="m-doc">
            <dt id="a74e37b7c91fdbbfb8b077f96ae5e6b2f">
              static bool <a href="#a74e37b7c91fdbbfb8b077f96ae5e6b2f" class="m-doc-self">False</a>
            </dt>
            <dd>A protected static var.</dd>
          </dl>
        </section>
        <section id="pro-attribs">
          <h2><a href="#pro-attribs">Protected variables</a></h2>
          <dl class="m-doc">
            <dt id="a7646ff8bc6f40c535eb3c281d969f8cd">
              std::string <a href="#a7646ff8bc6f40c535eb3c281d969f8cd" class="m-doc-self">logger</a>
            </dt>
            <dd>A protected variable.</dd>
          </dl>
        </section>
        <section id="pri-methods">
          <h2><a href="#pri-methods">Private functions</a></h2>
          <dl class="m-doc">
            <dt id="a28551ce6aa7f9f41c1360ed17737b65d">
              <span class="m-doc-wrap-bumper">auto <a href="#a28551ce6aa7f9f41c1360ed17737b65d" class="m-doc-self">doSomething</a>(</span><span class="m-doc-wrap">) const -&gt; int <span class="m-label m-flat m-warning">virtual</span></span>
            </dt>
            <dd>A documented private virtual function.</dd>
          </dl>
        </section>
        <section id="group-full-of-non-public-stuff-which-should-be-marked-as-such">
          <h2><a href="#group-full-of-non-public-stuff-which-should-be-marked-as-such">Group full of non-public stuff which should be marked as such</a></h2>
          <dl class="m-doc">
            <dt id="a82511584183fc6aa5505e0e4ce811580">
              <span class="m-doc-wrap-bumper">enum <a href="#a82511584183fc6aa5505e0e4ce811580" class="m-doc-self">Flag</a> { </span><span class="m-doc-wrap"> } <span class="m-label m-flat m-warning">protected</span></span>
            </dt>
            <dd>Protected flag in a group.</dd>
            <dt id="a4a7ac6e39fedaf79a0ceb0f8d2a3cb64">
              using <a href="#a4a7ac6e39fedaf79a0ceb0f8d2a3cb64" class="m-doc-self">Main</a> = void <span class="m-label m-flat m-warning">protected</span>
            </dt>
            <dd>Protected alias in a group.</dd>
            <dt id="a347f08e1aec78ec16125bac4c2577962">
              void* <a href="#a347f08e1aec78ec16125bac4c2577962" class="m-doc-self">variable</a> <span class="m-label m-flat m-warning">protected</span>
            </dt>
            <dd>Protected variable in a group.</dd>
            <dt id="a829faa7cd38054a51a303027eaee3b31">
              <span class="m-doc-wrap-bumper">void <a href="#a829faa7cd38054a51a303027eaee3b31" class="m-doc-self">foo</a>(</span><span class="m-doc-wrap">) const &amp; <span class="m-label m-flat m-warning">protected</span></span>
            </dt>
            <dd>Protected function in a group.</dd>
            <dt id="af5c2ec17b691bd71f7445c9ee886b82e">
              <span class="m-doc-wrap-bumper">auto <a href="#af5c2ec17b691bd71f7445c9ee886b82e" class="m-doc-self">doStuff</a>(</span><span class="m-doc-wrap">) -&gt; int <span class="m-label m-flat m-danger">private</span> <span class="m-label m-flat m-warning">pure virtual</span></span>
            </dt>
            <dd>Private virtual function in a group.</dd>
          </dl>
        </section>
        <section id="related">
          <h2><a href="#related">Related</a></h2>
          <dl class="m-doc">
            <dt id="a8150b7776c2a1749101acf22e868d091">
              <span class="m-doc-wrap-bumper">enum <a href="#a8150b7776c2a1749101acf22e868d091" class="m-doc-self">Enum</a> { </span><span class="m-doc-wrap"> }</span>
            </dt>
            <dd>An enum.</dd>
            <dt id="a7cc214a236ad3bb6ad435bdcf5262a3f">
              using <a href="#a7cc214a236ad3bb6ad435bdcf5262a3f" class="m-doc-self">Int</a> = int
            </dt>
            <dd>A typedef.</dd>
            <dt id="a3ffd74e95952eacd75f04a2b85d61845">
              using <a href="#a3ffd74e95952eacd75f04a2b85d61845" class="m-doc-self">Float</a> = float
            </dt>
            <dd>An using declaration.</dd>
            <dt id="a7708bd7aaec399e771a2b30db52e4d22">
              const int <a href="#a7708bd7aaec399e771a2b30db52e4d22" class="m-doc-self">Var</a> <span class="m-label m-flat m-primary">constexpr</span>
            </dt>
            <dd>A variable.</dd>
            <dt id="ac07863d69ae41a4e395b31f73b35fbcd">
              <span class="m-doc-wrap-bumper">void <a href="#ac07863d69ae41a4e395b31f73b35fbcd" class="m-doc-self">foo</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>A function.</dd>
            <dt id="af370f27ec90a92ed7656537eacb476e9">
              <span class="m-doc-wrap-bumper">#define <a href="#af370f27ec90a92ed7656537eacb476e9" class="m-doc-self">A_MACRO</a>(</span><span class="m-doc-wrap">foo)</span>
            </dt>
            <dd>A macro.</dd>
          </dl>
        </section>
      </div>
    </div>
  </div>
</article></main>
</body>
</html>
